v1.18.3

Compare Source

======

(2024-12-01)

Bug fixes

• Fixed uppercase ASCII hosts being rejected by :meth:URL.build() <yarl.URL.build> and :py:meth:~yarl.URL.with_host -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:954, :issue:1442.

Miscellaneous internal changes

• Improved performances of multiple path properties on cache miss -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1443.

v1.18.2

Compare Source

======

(2024-11-29)

No significant changes.

v1.18.1

Compare Source

======

(2024-11-29)

Miscellaneous internal changes

• Improved cache performance when :class:~yarl.URL objects are constructed from :py:meth:~yarl.URL.build with encoded=True -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1432.

• Improved cache performance for operations that produce a new :class:~yarl.URL object -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1434, :issue:1436.

v1.18.0

Compare Source

======

(2024-11-21)

Features

• Added keep_query and keep_fragment flags in the :py:meth:yarl.URL.with_path, :py:meth:yarl.URL.with_name and :py:meth:yarl.URL.with_suffix methods, allowing users to optionally retain the query string and fragment in the resulting URL when replacing the path -- by :user:paul-nameless.

  Related issues and pull requests on GitHub:
  :issue:111, :issue:1421.

Contributor-facing changes

• Started running downstream aiohttp tests in CI -- by :user:Cycloctane.

  Related issues and pull requests on GitHub:
  :issue:1415.

Miscellaneous internal changes

• Improved performance of converting :class:~yarl.URL to a string -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1422.

v1.17.2

Compare Source

======

(2024-11-17)

Bug fixes

• Stopped implicitly allowing the use of Cython pre-release versions when
  building the distribution package -- by :user:ajsanchezsanz and
  :user:markgreene74.

  Related issues and pull requests on GitHub:
  :issue:1411, :issue:1412.

• Fixed a bug causing :attr:~yarl.URL.port to return the default port when the given port was zero
  -- by :user:gmacon.

  Related issues and pull requests on GitHub:
  :issue:1413.

Features

• Make error messages include details of incorrect type when port is not int in :py:meth:~yarl.URL.build.
  -- by :user:Cycloctane.

  Related issues and pull requests on GitHub:
  :issue:1414.

Packaging updates and notes for downstreams

• Stopped implicitly allowing the use of Cython pre-release versions when
  building the distribution package -- by :user:ajsanchezsanz and
  :user:markgreene74.

  Related issues and pull requests on GitHub:
  :issue:1411, :issue:1412.

Miscellaneous internal changes

• Improved performance of the :py:meth:~yarl.URL.joinpath method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1418.

v1.17.1

Compare Source

======

(2024-10-30)

Miscellaneous internal changes

• Improved performance of many :class:~yarl.URL methods -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1396, :issue:1397, :issue:1398.

• Improved performance of passing a dict or str to :py:meth:~yarl.URL.extend_query -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1401.

v1.17.0

Compare Source

======

(2024-10-28)

Features

• Added :attr:~yarl.URL.host_port_subcomponent which returns the :rfc:3986#section-3.2.2 host and :rfc:3986#section-3.2.3 port subcomponent -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1375.

v1.16.0

Compare Source

======

(2024-10-21)

Bug fixes

• Fixed blocking I/O to load Python code when creating a new :class:~yarl.URL with non-ascii characters in the network location part -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1342.

Removals and backward incompatible breaking changes

• Migrated to using a single cache for encoding hosts -- by :user:bdraco.

  Passing ip_address_size and host_validate_size to :py:meth:~yarl.cache_configure is deprecated in favor of the new encode_host_size parameter and will be removed in a future release. For backwards compatibility, the old parameters affect the encode_host cache size.

  Related issues and pull requests on GitHub:
  :issue:1348, :issue:1357, :issue:1363.

Miscellaneous internal changes

• Improved performance of constructing :class:~yarl.URL -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1336.

• Improved performance of calling :py:meth:~yarl.URL.build and constructing unencoded :class:~yarl.URL -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1345.

• Reworked the internal encoding cache to improve performance on cache hit -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1369.

v1.15.5

Compare Source

======

(2024-10-18)

Miscellaneous internal changes

• Improved performance of the :py:meth:~yarl.URL.joinpath method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1304.

• Improved performance of the :py:meth:~yarl.URL.extend_query method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1305.

• Improved performance of the :py:meth:~yarl.URL.origin method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1306.

• Improved performance of the :py:meth:~yarl.URL.with_path method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1307.

• Improved performance of the :py:meth:~yarl.URL.with_query method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1308, :issue:1328.

• Improved performance of the :py:meth:~yarl.URL.update_query method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1309, :issue:1327.

• Improved performance of the :py:meth:~yarl.URL.join method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1313.

• Improved performance of :class:~yarl.URL equality checks -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1315.

• Improved performance of :class:~yarl.URL methods that modify the network location -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1316.

• Improved performance of the :py:meth:~yarl.URL.with_fragment method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1317.

• Improved performance of calculating the hash of :class:~yarl.URL objects -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1318.

• Improved performance of the :py:meth:~yarl.URL.relative method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1319.

• Improved performance of the :py:meth:~yarl.URL.with_name method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1320.

• Improved performance of :attr:~yarl.URL.parent -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1321.

• Improved performance of the :py:meth:~yarl.URL.with_scheme method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1322.

v1.15.4

Compare Source

======

(2024-10-16)

Miscellaneous internal changes

• Improved performance of the quoter when all characters are safe -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1288.

• Improved performance of unquoting strings -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1292, :issue:1293.

• Improved performance of calling :py:meth:~yarl.URL.build -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1297.

v1.15.3

Compare Source

======

(2024-10-15)

Bug fixes

• Fixed :py:meth:~yarl.URL.build failing to validate paths must start with a / when passing authority -- by :user:bdraco.

  The validation only worked correctly when passing host.

  Related issues and pull requests on GitHub:
  :issue:1265.

Removals and backward incompatible breaking changes

• Removed support for Python 3.8 as it has reached end of life -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1203.

Miscellaneous internal changes

• Improved performance of constructing :class:~yarl.URL when the net location is only the host -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1271.

v1.15.2

Compare Source

======

(2024-10-13)

Miscellaneous internal changes

• Improved performance of converting :class:~yarl.URL to a string -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1234.

• Improved performance of :py:meth:~yarl.URL.joinpath -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1248, :issue:1250.

• Improved performance of constructing query strings from :class:~multidict.MultiDict -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1256.

• Improved performance of constructing query strings with int values -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1259.

v1.15.1

Compare Source

======

(2024-10-12)

Miscellaneous internal changes

• Improved performance of calling :py:meth:~yarl.URL.build -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1222.

• Improved performance of all :class:~yarl.URL methods that create new :class:~yarl.URL objects -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1226.

• Improved performance of :class:~yarl.URL methods that modify the network location -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1229.

v1.15.0

Compare Source

======

(2024-10-11)

Bug fixes

• Fixed validation with :py:meth:~yarl.URL.with_scheme when passed scheme is not lowercase -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1189.

Features

• Started building armv7l wheels -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1204.

Miscellaneous internal changes

• Improved performance of constructing unencoded :class:~yarl.URL objects -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1188.

• Added a cache for parsing hosts to reduce overhead of encoding :class:~yarl.URL -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1190.

• Improved performance of constructing query strings from :class:~collections.abc.Mapping -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1193.

• Improved performance of converting :class:~yarl.URL objects to strings -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1198.

v1.14.0

Compare Source

======

(2024-10-08)

Packaging updates and notes for downstreams

• Switched to using the :mod:propcache <propcache.api> package for property caching
  -- by :user:bdraco.

  The :mod:propcache <propcache.api> package is derived from the property caching
  code in :mod:yarl and has been broken out to avoid maintaining it for multiple
  projects.

  Related issues and pull requests on GitHub:
  :issue:1169.

Contributor-facing changes

• Started testing with Hypothesis -- by :user:webknjaz and :user:bdraco.

  Special thanks to :user:Zac-HD for helping us get started with this framework.

  Related issues and pull requests on GitHub:
  :issue:860.

Miscellaneous internal changes

• Improved performance of :py:meth:~yarl.URL.is_default_port when no explicit port is set -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1168.

• Improved performance of converting :class:~yarl.URL to a string when no explicit port is set -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1170.

• Improved performance of the :py:meth:~yarl.URL.origin method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1175.

• Improved performance of encoding hosts -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1176.

v1.13.1

Compare Source

======

(2024-09-27)

Miscellaneous internal changes

• Improved performance of calling :py:meth:~yarl.URL.build with authority -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1163.

v1.13.0

Compare Source

======

(2024-09-26)

Bug fixes

• Started rejecting ASCII hostnames with invalid characters. For host strings that
  look like authority strings, the exception message includes advice on what to do
  instead -- by :user:mjpieters.

  Related issues and pull requests on GitHub:
  :issue:880, :issue:954.

• Fixed IPv6 addresses missing brackets when the :class:~yarl.URL was converted to a string -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1157, :issue:1158.

Features

• Added :attr:~yarl.URL.host_subcomponent which returns the :rfc:3986#section-3.2.2 host subcomponent -- by :user:bdraco.

  The only current practical difference between :attr:~yarl.URL.raw_host and :attr:~yarl.URL.host_subcomponent is that IPv6 addresses are returned bracketed.

  Related issues and pull requests on GitHub:
  :issue:1159.

v1.12.1

Compare Source

======

(2024-09-23)

No significant changes.

v1.12.0

Compare Source

======

(2024-09-23)

Features

• Added :attr:~yarl.URL.path_safe to be able to fetch the path without %2F and %25 decoded -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1150.

Removals and backward incompatible breaking changes

• Restore decoding %2F (/) in URL.path -- by :user:bdraco.

  This change restored the behavior before :issue:1057.

  Related issues and pull requests on GitHub:
  :issue:1151.

Miscellaneous internal changes

• Improved performance of processing paths -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1143.

v1.11.1

Compare Source

======

(2024-09-09)

Bug fixes

• Allowed scheme replacement for relative URLs if the scheme does not require a host -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:280, :issue:1138.

• Allowed empty host for URL schemes other than the special schemes listed in the WHATWG URL spec -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1136.

Features

• Loosened restriction on integers as query string values to allow classes that implement __int__ -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1139.

Miscellaneous internal changes

• Improved performance of normalizing paths -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1137.

v1.11.0

Compare Source

======

(2024-09-08)

Features

• Added :meth:URL.extend_query() <yarl.URL.extend_query> method, which can be used to extend parameters without replacing same named keys -- by :user:bdraco.

  This method was primarily added to replace the inefficient hand rolled method currently used in aiohttp.

  Related issues and pull requests on GitHub:
  :issue:1128.

Miscellaneous internal changes

• Improved performance of the Cython cached_property implementation -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1122.

• Simplified computing ports by removing unnecessary code -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1123.

• Improved performance of encoding non IPv6 hosts -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1125.

• Improved performance of :meth:URL.build() <yarl.URL.build> when the path, query string, or fragment is an empty string -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1126.

• Improved performance of the :meth:URL.update_query() <yarl.URL.update_query> method -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1130.

• Improved performance of processing query string changes when arguments are :class:str -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1131.

v1.10.0

Compare Source

======

(2024-09-06)

Bug fixes

• Fixed joining a path when the existing path was empty -- by :user:bdraco.

  A regression in :meth:URL.join() <yarl.URL.join> was introduced in :issue:1082.

  Related issues and pull requests on GitHub:
  :issue:1118.

Features

• Added :meth:URL.without_query_params() <yarl.URL.without_query_params> method, to drop some parameters from query string -- by :user:hongquan.

  Related issues and pull requests on GitHub:
  :issue:774, :issue:898, :issue:1010.

• The previously protected types _SimpleQuery, _QueryVariable, and _Query are now available for use externally as SimpleQuery, QueryVariable, and Query -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1050, :issue:1113.

Contributor-facing changes

• Replaced all :class:~typing.Optional with :class:~typing.Union -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1095.

Miscellaneous internal changes

• Significantly improved performance of parsing the network location -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1112.

• Added internal types to the cache to prevent future refactoring errors -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1117.

v1.9.11

Compare Source

======

(2024-09-04)

Bug fixes

• Fixed a :exc:TypeError with MultiDictProxy and Python 3.8 -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1084, :issue:1105, :issue:1107.

Miscellaneous internal changes

• Improved performance of encoding hosts -- by :user:bdraco.

  Previously, the library would unconditionally try to parse a host as an IP Address. The library now avoids trying to parse a host as an IP Address if the string is not in one of the formats described in :rfc:3986#section-3.2.2.

  Related issues and pull requests on GitHub:
  :issue:1104.

v1.9.10

Compare Source

======

(2024-09-04)

Bug fixes

• :meth:URL.join() <yarl.URL.join> has been changed to match
  :rfc:3986 and align with
  :meth:/ operation <yarl.URL.__truediv__> and :meth:URL.joinpath() <yarl.URL.joinpath>
  when joining URLs with empty segments.
  Previously :py:func:urllib.parse.urljoin was used,
  which has known issues with empty segments
  (python/cpython#84774 <https://github.com/python/cpython/issues/84774>_).

  Due to the semantics of :meth:URL.join() <yarl.URL.join>, joining an
  URL with scheme requires making it relative, prefixing with ./.

  .. code-block:: pycon

  URL("https://web.archive.org/web/").join(URL("./https://github.com/aio-libs/yarl"))
  URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')

  Empty segments are honored in the base as well as the joined part.

  .. code-block:: pycon

  URL("https://web.archive.org/web/https://").join(URL("github.com/aio-libs/yarl"))
  URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')

  -- by :user:commonism

  This change initially appeared in 1.9.5 but was reverted in 1.9.6 to resolve a problem with query string handling.

  Related issues and pull requests on GitHub:
  :issue:1039, :issue:1082.

Features

• Added :attr:~yarl.URL.absolute which is now preferred over URL.is_absolute() -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1100.

v1.9.9

Compare Source

=====

(2024-09-04)

Bug fixes

• Added missing type on :attr:~yarl.URL.port -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1097.

v1.9.8

Compare Source

=====

(2024-09-03)

Features

• Covered the :class:~yarl.URL object with types -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1084.

• Cache parsing of IP Addresses when encoding hosts -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1086.

Contributor-facing changes

• Covered the :class:~yarl.URL object with types -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1084.

Miscellaneous internal changes

• Improved performance of handling ports -- by :user:bdraco.

  Related issues and pull requests on GitHub:
  :issue:1081.

v1.9.7

Compare Source

=====

(2024-09-01)

Removals and backward incompatible breaking changes

• Removed support :rfc:3986#section-3.2.3 port normalization when the scheme is not one of http, https, wss, or ws -- by :user:bdraco.

  Support for port normalization was recently added in :issue:1033 and contained code that would do blocking I/O if the scheme was not one of the four listed above. The code has been removed because this library is intended to be safe for usage with :mod:asyncio.

  Related issues and pull requests on GitHub:
  :issue:1076.

Miscellaneous internal changes

• Improved performance of property caching -- by :user:bdraco.

  The reify implementation from aiohttp was adapted to replace the internal cached_property implementation.

  Related issues and pull requests on GitHub:
  :issue:1070.

v1.9.6

Compare Source

=====

(2024-08-30)

Bug fixes

• Reverted :rfc:3986 compatible :meth:URL.join() <yarl.URL.join> honoring empty segments which was introduced in :issue:1039.

  This change introduced a regression handling query string parameters with joined URLs. The change was reverted to maintain compatibility with the previous behavior.

  Related issues and pull requests on GitHub:
  :issue:1067.

v1.9.5

Compare Source

=====

(2024-08-30)

Bug fixes

• Joining URLs with empty segments has been changed
  to match :rfc:3986.

  Previously empty segments would be removed from path,
  breaking use-cases such as

  .. code-block:: python

  URL("https://web.archive.org/web/") / "https://github.com/"

  Now :meth:/ operation <yarl.URL.__truediv__> and :meth:URL.joinpath() <yarl.URL.joinpath>
  keep empty segments, but do not introduce new empty segments.
  e.g.

  .. code-block:: python

  URL("https://example.org/") / ""

  does not introduce an empty segment.

  -- by :user:commonism and :user:youtux

  Related issues and pull requests on GitHub:
  :issue:1026.

• The default protocol ports of well-known URI schemes are now taken into account
  during the normalization of the URL string representation in accordance with
  :rfc:3986#section-3.2.3.

  Specified ports are removed from the :class:str representation of a :class:~yarl.URL
  if the port matches the scheme's default port -- by :user:commonism.

  Related issues and pull requests on GitHub:
  :issue:1033.

• :meth:URL.join() <yarl.URL.join> has been changed to match
  :rfc:3986 and align with
  :meth:/ operation <yarl.URL.__truediv__> and :meth:URL.joinpath() <yarl.URL.joinpath>
  when joining URLs with empty segments.
  Previously :py:func:urllib.parse.urljoin was used,
  which has known issues with empty segments
  (python/cpython#84774 <https://github.com/python/cpython/issues/84774>_).

  Due to the semantics of :meth:URL.join() <yarl.URL.join>, joining an
  URL with scheme requires making it relative, prefixing with ./.

  .. code-block:: pycon

  URL("https://web.archive.org/web/").join(URL("./https://github.com/aio-libs/yarl"))
  URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')

  Empty segments are honored in the base as well as the joined part.

  .. code-block:: pycon

  URL("https://web.archive.org/web/https://").join(URL("github.com/aio-libs/yarl"))
  URL('https://web.archive.org/web/https://github.com/aio-libs/yarl')

  -- by :user:commonism

  Related issues and pull requests on GitHub:
  :issue:1039.

Removals and backward incompatible breaking changes

• Stopped decoding %2F (/) in URL.path, as this could lead to code incorrectly treating it as a path separator
  -- by :user:Dreamsorcerer.

  Related issues and pull requests on GitHub:
  :issue:1057.

• Dropped support for Python 3.7 -- by :user:Dreamsorcerer.

  Related issues and pull requests on GitHub:
  :issue:1016.

Improved documentation

• On the :doc:Contributing docs <contributing/guidelines> page,
  a link to the Towncrier philosophy has been fixed.

  Related issues and pull requests on GitHub:
  :issue:981.

• The pre-existing :meth:/ magic method <yarl.URL.__truediv__>
  has been documented in the API reference -- by :user:commonism.

  Related issues and pull requests on GitHub:
  :issue:1026.

Packaging updates and notes for downstreams

• A flaw in the logic for copying the project directory into a
  temporary folder that led to infinite recursion when :envvar:TMPDIR
  was set to a project subdirectory path. This was happening in Fedora
  and its downstream due to the use of pyproject-rpm-macros <https://src.fedoraproject.org/rpms/pyproject-rpm-macros>__. It was
  only reproducible with pip wheel and was not affecting the
  pyproject-build users.

  -- by :user:hroncok and :user:webknjaz

  Related issues and pull requests on GitHub:
  :issue:992, :issue:1014.

• Support Python 3.13 and publish non-free-threaded wheels

  Related issues and pull requests on GitHub:
  :issue:1054.

Contributor-facing changes

• The CI/CD setup has been updated to test arm64 wheels
  under macOS 14, except for Python 3.7 that is unsupported
  in that environment -- by :user:webknjaz.

  Related issues and pull requests on GitHub:
  :issue:1015.

• Removed unused type ignores and casts -- by :user:hauntsaninja.

  Related issues and pull requests on GitHub:
  :issue:1031.

Miscellaneous internal changes

• port, scheme, and raw_host are now cached_property -- by :user:bdraco.

  aiohttp accesses these properties quite often, which cause :mod:urllib to build the _hostinfo property every time. port, scheme, and raw_host are now cached properties, which will improve performance.

  Related issues and pull requests on GitHub:
  :issue:1044, :issue:1058.

v1.9.4

Compare Source

==================

Bug fixes

• Started raising :py:exc:TypeError when a string value is passed into
  :py:meth:~yarl.URL.build as the port argument -- by :user:commonism.

  Previously the empty string as port would create malformed URLs when rendered as string representations. (:issue:883)

Packaging updates and notes for downstreams

• The leading -- has been dropped from the :pep:517 in-tree build
  backend config setting names. --pure-python is now just pure-python
  -- by :user:webknjaz.

  The usage now looks as follows:

  .. code-block:: console

  $ python -m build \
      --config-setting=pure-python=true \
      --config-setting=with-cython-tracing=true
  

  (:issue:963)

Contributor-facing changes

• A step-by-step :doc:Release Guide <contributing/release_guide> guide has
  been added, describing how to release yarl -- by :user:webknjaz.

  This is primarily targeting maintainers. (:issue:960)

• Coverage collection has been implemented for the Cython modules
  -- by :user:webknjaz.

  It will also be reported to Codecov from any non-release CI jobs.

  To measure coverage in a development environment, yarl can be
  installed in editable mode:

  .. code-block:: console

  $ python -Im pip install -e .
  

  Editable install produces C-files required for the Cython coverage
  plugin to map the measurements back to the PYX-files.

  :issue:961

• It is now possible to request line tracing in Cython builds using the
  with-cython-tracing :pep:517 config setting
  -- :user:webknjaz.

  This can be used in CI and development environment to measure coverage
  on Cython modules, but is not normally useful to the end-users or
  downstream packagers.

  Here's a usage example:

  .. code-block:: console

  $ python -Im pip install . --config-settings=with-cython-tracing=true
  

  For editable installs, this setting is on by default. Otherwise, it's
  off unless requested explicitly.

  The following produces C-files required for the Cython coverage
  plugin to map the measurements back to the PYX-files:

  .. code-block:: console

  $ python -Im pip install -e .
  

  Alternatively, the YARL_CYTHON_TRACING=1 environment variable
  can be set to do the same as the :pep:517 config setting.

  :issue:962

v1.9.3

Compare Source

==================

Bug fixes

• Stopped dropping trailing slashes in :py:meth:~yarl.URL.joinpath -- by :user:gmacon. (:issue:862, :issue:866)
• Started accepting string subclasses in __truediv__() operations (URL / segment) -- by :user:mjpieters. (:issue:871, :issue:884)
• Fixed the human representation of URLs with square brackets in usernames and passwords -- by :user:mjpieters. (:issue:876, :issue:882)
• Updated type hints to include URL.missing_port(), URL.__bytes__()
  and the encoding argument to :py:meth:~yarl.URL.joinpath
  -- by :user:mjpieters. (:issue:891)

Packaging updates and notes for downstreams

• Integrated Cython 3 to enable building yarl under Python 3.12 -- by :user:mjpieters. (:issue:829, :issue:881)

• Declared modern setuptools.build_meta as the :pep:517 build
  backend in :file:pyproject.toml explicitly -- by :user:webknjaz. (:issue:886)

• Converted most of the packaging setup into a declarative :file:setup.cfg
  config -- by :user:webknjaz. (:issue:890)

• The packaging is replaced from an old-fashioned :file:setup.py to an
  in-tree :pep:517 build backend -- by :user:webknjaz.

  Whenever the end-users or downstream packagers need to build yarl from
  source (a Git checkout or an sdist), they may pass a config_settings
  flag --pure-python. If this flag is not set, a C-extension will be built
  and included into the distribution.

  Here is how this can be done with pip:

  .. code-block:: console

  $ python -m pip install . --config-settings=--pure-python=false
  

  This will also work with -e | --editable.

  The same can be achieved via pypa/build:

  .. code-block:: console

  $ python -m build --config-setting=--pure-python=false
  

  Adding -w | --wheel can force pypa/build produce a wheel from source
  directly, as opposed to building an sdist and then building from it. (:issue:893)

  .. attention::

  v1.9.3 was the only version using the --pure-python setting name.
  Later versions dropped the -- prefix, making it just pure-python.

• Declared Python 3.12 supported officially in the distribution package metadata
  -- by :user:edgarrmondragon. (:issue:942)

Contributor-facing changes

• A regression test for no-host URLs was added per :issue:821
  and :rfc:3986 -- by :user:kenballus. (:issue:821, :issue:822)

• Started testing yarl against Python 3.12 in CI -- by :user:mjpieters. (:issue:881)

• All Python 3.12 jobs are now marked as required to pass in CI
  -- by :user:edgarrmondragon. (:issue:942)

• MyST is now integrated in Sphinx -- by :user:webknjaz.

  This allows the contributors to author new documents in Markdown
  when they have difficulties with going straight RST. (:issue:953)